<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>spi: xspi.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">spi
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xspi_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xspi.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga44a2dc795761b35ed0ebdd6989675022"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#ga44a2dc795761b35ed0ebdd6989675022">XSpi_Abort</a> (<a class="el" href="struct_x_spi.html">XSpi</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga44a2dc795761b35ed0ebdd6989675022"><td class="mdescLeft">&#160;</td><td class="mdescRight">Aborts a transfer in progress by setting the stop bit in the control register, then resetting the FIFOs if present.  <a href="group__spi.html#ga44a2dc795761b35ed0ebdd6989675022">More...</a><br/></td></tr>
<tr class="separator:ga44a2dc795761b35ed0ebdd6989675022"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga858155b42d5a1da8efe06c9098e40b2d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">XSpi_CfgInitialize</a> (<a class="el" href="struct_x_spi.html">XSpi</a> *InstancePtr, <a class="el" href="struct_x_spi___config.html">XSpi_Config</a> *Config, UINTPTR EffectiveAddr)</td></tr>
<tr class="memdesc:ga858155b42d5a1da8efe06c9098e40b2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a specific <a class="el" href="struct_x_spi.html" title="The XSpi driver instance data. ">XSpi</a> instance such that the driver is ready to use.  <a href="group__spi.html#ga858155b42d5a1da8efe06c9098e40b2d">More...</a><br/></td></tr>
<tr class="separator:ga858155b42d5a1da8efe06c9098e40b2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga87fdaad742a2669200c9b2617e5c86ea"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#ga87fdaad742a2669200c9b2617e5c86ea">XSpi_Start</a> (<a class="el" href="struct_x_spi.html">XSpi</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga87fdaad742a2669200c9b2617e5c86ea"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables interrupts for the SPI device.  <a href="group__spi.html#ga87fdaad742a2669200c9b2617e5c86ea">More...</a><br/></td></tr>
<tr class="separator:ga87fdaad742a2669200c9b2617e5c86ea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad4bb67cfcfe73844ffb1917b11d5284c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#gad4bb67cfcfe73844ffb1917b11d5284c">XSpi_Stop</a> (<a class="el" href="struct_x_spi.html">XSpi</a> *InstancePtr)</td></tr>
<tr class="memdesc:gad4bb67cfcfe73844ffb1917b11d5284c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function stops the SPI device by disabling interrupts and disabling the device itself.  <a href="group__spi.html#gad4bb67cfcfe73844ffb1917b11d5284c">More...</a><br/></td></tr>
<tr class="separator:gad4bb67cfcfe73844ffb1917b11d5284c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga343938fcdf672bec329d876a146178cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#ga343938fcdf672bec329d876a146178cd">XSpi_Reset</a> (<a class="el" href="struct_x_spi.html">XSpi</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga343938fcdf672bec329d876a146178cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the SPI device by writing to the Software Reset register.  <a href="group__spi.html#ga343938fcdf672bec329d876a146178cd">More...</a><br/></td></tr>
<tr class="separator:ga343938fcdf672bec329d876a146178cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4c44c082ef2d2b9cf4ba3db8bcebd954"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">XSpi_Transfer</a> (<a class="el" href="struct_x_spi.html">XSpi</a> *InstancePtr, u8 *SendBufPtr, u8 *RecvBufPtr, unsigned int ByteCount)</td></tr>
<tr class="memdesc:ga4c44c082ef2d2b9cf4ba3db8bcebd954"><td class="mdescLeft">&#160;</td><td class="mdescRight">Transfers the specified data on the SPI bus.  <a href="group__spi.html#ga4c44c082ef2d2b9cf4ba3db8bcebd954">More...</a><br/></td></tr>
<tr class="separator:ga4c44c082ef2d2b9cf4ba3db8bcebd954"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga162523a3e9b29f063701db303ac8cf17"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#ga162523a3e9b29f063701db303ac8cf17">XSpi_SetSlaveSelect</a> (<a class="el" href="struct_x_spi.html">XSpi</a> *InstancePtr, u32 SlaveMask)</td></tr>
<tr class="memdesc:ga162523a3e9b29f063701db303ac8cf17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects or deselect the slave with which the master communicates.  <a href="group__spi.html#ga162523a3e9b29f063701db303ac8cf17">More...</a><br/></td></tr>
<tr class="separator:ga162523a3e9b29f063701db303ac8cf17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8043891b8f68a3291bd035be74aa6b94"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#ga8043891b8f68a3291bd035be74aa6b94">XSpi_GetSlaveSelect</a> (<a class="el" href="struct_x_spi.html">XSpi</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga8043891b8f68a3291bd035be74aa6b94"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current slave select bit mask for the SPI device.  <a href="group__spi.html#ga8043891b8f68a3291bd035be74aa6b94">More...</a><br/></td></tr>
<tr class="separator:ga8043891b8f68a3291bd035be74aa6b94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabc09f4d503de2a772e5079ac46fc62b6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#gabc09f4d503de2a772e5079ac46fc62b6">XSpi_SetStatusHandler</a> (<a class="el" href="struct_x_spi.html">XSpi</a> *InstancePtr, void *CallBackRef, <a class="el" href="group__spi.html#gaa9c3c5101d73a626380c46bcc906069e">XSpi_StatusHandler</a> FuncPtr)</td></tr>
<tr class="memdesc:gabc09f4d503de2a772e5079ac46fc62b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the status callback function, the status handler, which the driver calls when it encounters conditions that should be reported to the higher layer software.  <a href="group__spi.html#gabc09f4d503de2a772e5079ac46fc62b6">More...</a><br/></td></tr>
<tr class="separator:gabc09f4d503de2a772e5079ac46fc62b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf3863f11d27469d8797424319601c980"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__spi.html#gaf3863f11d27469d8797424319601c980">XSpi_InterruptHandler</a> (void *InstancePtr)</td></tr>
<tr class="memdesc:gaf3863f11d27469d8797424319601c980"><td class="mdescLeft">&#160;</td><td class="mdescRight">The interrupt handler for SPI interrupts.  <a href="group__spi.html#gaf3863f11d27469d8797424319601c980">More...</a><br/></td></tr>
<tr class="separator:gaf3863f11d27469d8797424319601c980"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
